Update dependencies and configuration files #846

kamiazya · 2024-06-12T15:43:43Z

This pull request updates the dependencies and configuration files of the project.

It includes changes such as:

migrating the package manager to pnpm from yarn
setting the package manager to [email protected]
migrating the formatter and linter to biome from eslint and prettier
migrating the build and test tool to vite/vitest from rollup/jest
introduces Changeset
removes the VSCode settings file
updates the package.json exports
adds a typecheck script for TypeScript type checking
adds a "provenance" flag to the publishConfig in package.json
explicitly states that Node.js 16 or higher should be guaranteed to work with the latest TypeDoc.

Summary by CodeRabbit

New Features
- Introduced a comprehensive CI/CD workflow for automated testing, building, and releasing.
- Added configuration settings for versioning and publishing tools.
- Updated package management to use pnpm.
Bug Fixes
- Migrated formatter and linter to biome from eslint and prettier.
- Updated dependencies and configuration files for better compatibility.
Refactor
- Refactored import statements and initialization logic for improved code structure and readability.
Chores
- Added configuration files for tools like Biome, Changeset, and Vite.
- Updated Node.js version specification and package dependencies.
- Enhanced CI/CD workflow with specific job configurations and steps.

…rk with the latest TypeDoc

changeset-bot · 2024-06-12T16:39:38Z

🦋 Changeset detected

Latest commit: ef811a5

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2024-06-12T16:45:20Z

Walkthrough

The changes introduce multiple updates and enhancements to the typedoc-plugin-mermaid package, including migrating tools, updating configurations, refining CI/CD workflows, and improving code quality and build processes. These updates streamline development, enhance compatibility with Node.js 16+, and ensure robust CI/CD practices.

Changes

File/Path	Summary
`.changeset/README.md`	Added documentation for `@changesets/cli` tool.
`.changeset/*.md`	Introduced patches and updates for `typedoc-plugin-mermaid`, including tool migrations and type checks.
`.changeset/config.json`	Added configuration settings for changelogs and repository information.
`.github/actions/setup/action.yaml`	Introduced a setup action for CI/CD workflows.
`.github/workflows/cicd.yaml`	Added a CI/CD workflow with jobs for linting, type checking, building, testing, and releasing.
`.node-version`	Specified Node.js version as `20`.
`biome.json`	Added configuration for Biome tool.
`example/package.json`	Updated dependencies and set package as private.
`example/tsconfig.json`	Removed exclusion of `node_modules`.
`example/typedoc.json`	Updated paths for `entryPoints` and `plugin`.
`package.json`	Updated main file paths, scripts, dependencies, and added new dev dependencies.
`pnpm-workspace.yaml`	Configured workspace for two packages.
`src/index.ts`	Updated import statement for `MermaidPlugin`.
`src/plugin.ts`	Rearranged imports and updated method parameter names.
`test/plugin.test.ts`	Refactored initialization of `MermaidPlugin` within a `beforeAll` block.
`tsconfig.json`	Modified `include` and `exclude` sections for alignment.
`vite.config.ts`	Configured Vite for building the library with specified entry points and formats.

Poem

In the realm of code so bright,
Changes dance in pure delight.
Tools now migrate, scripts refine,
CI/CD workflows align.
Node.js stands tall, version twenty,
With Biome's touch, fixes plenty.
Typedoc sings with Mermaid's charm,
In this update, there's no alarm.
🌟✨🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 73fdae3 and 9e712f0.

Files ignored due to path filters (3)

pnpm-lock.yaml is excluded by !pnpm-lock.yaml
test/__snapshots__/plugin.test.ts.snap is excluded by !**/*.snap
yarn.lock is excluded by !**/*.lock

Files selected for processing (26)

.changeset/README.md (1 hunks)
.changeset/chilled-bottles-tan.md (1 hunks)
.changeset/config.json (1 hunks)
.changeset/kind-gorillas-push.md (1 hunks)
.changeset/lovely-scissors-sin.md (1 hunks)
.changeset/lucky-weeks-enjoy.md (1 hunks)
.changeset/orange-hotels-deny.md (1 hunks)
.changeset/pretty-dolphins-march.md (1 hunks)
.changeset/proud-dots-eat.md (1 hunks)
.changeset/slimy-tools-develop.md (1 hunks)
.changeset/soft-ants-thank.md (1 hunks)
.changeset/weak-apples-argue.md (1 hunks)
.github/actions/setup/action.yaml (1 hunks)
.github/workflows/cicd.yaml (1 hunks)
.node-version (1 hunks)
biome.json (1 hunks)
example/package.json (1 hunks)
example/tsconfig.json (1 hunks)
example/typedoc.json (1 hunks)
package.json (2 hunks)
pnpm-workspace.yaml (1 hunks)
src/index.ts (1 hunks)
src/plugin.ts (2 hunks)
test/plugin.test.ts (1 hunks)
tsconfig.json (1 hunks)
vite.config.ts (1 hunks)

Files skipped from review due to trivial changes (19)

.changeset/README.md
.changeset/chilled-bottles-tan.md
.changeset/config.json
.changeset/kind-gorillas-push.md
.changeset/lovely-scissors-sin.md
.changeset/lucky-weeks-enjoy.md
.changeset/pretty-dolphins-march.md
.changeset/proud-dots-eat.md
.changeset/slimy-tools-develop.md
.changeset/soft-ants-thank.md
.changeset/weak-apples-argue.md
.github/actions/setup/action.yaml
.node-version
biome.json
example/package.json
example/tsconfig.json
src/index.ts
tsconfig.json
vite.config.ts

Additional comments not posted (6)

pnpm-workspace.yaml (1)

1-3: The workspace configuration for pnpm is correctly set up to include both the root and the example directory.

example/typedoc.json (1)

2-3: The updates to entryPoints and plugin paths improve clarity and correctness in the TypeDoc configuration.

.changeset/orange-hotels-deny.md (1)

1-7: The Changeset entry effectively documents the migration to pnpm and the setup of the pnpm workspace, providing clear information for changelog generation.

package.json (1)

Line range hint 5-58: The updates in package.json correctly reflect the migration to new tools and configurations, including the new scripts for biome and vite, and the updated dependencies. The explicit setting of Node.js version requirements and the addition of the provenance flag in publishConfig are also noteworthy improvements.

test/plugin.test.ts (1)

3-11: Updated import and initialization method aligns with modern JavaScript practices and ensures proper asynchronous handling.

src/plugin.ts (1)

Line range hint 1-148: The changes in src/plugin.ts improve code organization and readability. Consider adding more detailed comments in complex methods to enhance maintainability.

.github/workflows/cicd.yaml

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9e712f0 and ef811a5.

Files selected for processing (1)

.github/workflows/cicd.yaml (1 hunks)

Files skipped from review as they are similar to previous changes (1)

.github/workflows/cicd.yaml

kamiazya added 14 commits June 12, 2024 19:01

Introduce Changeset

a4e39b0

Migrate package manager to pnpm from yarn

ad55c3c

Set package manager to [email protected]

74bc687

Migrate formater and linter to biome from eslint and prettier

25d794a

chore: Migrate build and test tool to vite/vitest from rollup/jest

47299c0

Setup pnpm workspace and ignore "example" in Changeset configuration

aba47a1

Remove VSCode settings file

6c6ebc4

Update dependencies and configuration files

dd27cc5

Remove .github/FUNDING.yml

2516d24

Explicitly state that Node.js 16 or higher should be guaranteed to wo…

a00ce4b

…rk with the latest TypeDoc

Add typecheck script for TypeScript type checking

fe91d93

Update package.json exports

2afc76a

Add "provenance" flag to publishConfig in package.json

6cfb27d

Update pnpm-lock.yaml

38fec36

kamiazya force-pushed the upgrade-typedoc25 branch from c2f277f to f5a852d Compare June 12, 2024 15:48

Update CI/CD Workflow

2cbd6ee

kamiazya force-pushed the upgrade-typedoc25 branch from f5a852d to 2cbd6ee Compare June 12, 2024 15:51

kamiazya added 6 commits June 13, 2024 00:53

Fix CI/CD to checkout before setup

5c38965

Fix Setup composite action to set shell on Install Dependencies job

cd8ce1d

Fix format with biome and fix biome configs

f369c68

Update MermaidPlugin initialization in plugin.test.ts

9fd3c76

Fix format

11570a7

Fix env variable name

9e712f0

kamiazya marked this pull request as ready for review June 12, 2024 16:55

Update test job, run only linux

ef811a5

coderabbitai bot reviewed Jun 12, 2024

View reviewed changes

.github/workflows/cicd.yaml Outdated Show resolved Hide resolved

coderabbitai bot reviewed Jun 12, 2024

View reviewed changes

kamiazya merged commit b5f14d9 into main Jun 12, 2024
13 checks passed

kamiazya deleted the upgrade-typedoc25 branch June 12, 2024 17:05

github-actions bot mentioned this pull request Jun 12, 2024

Version Packages #847

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependencies and configuration files #846

Update dependencies and configuration files #846

kamiazya commented Jun 12, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jun 12, 2024 •

edited

Loading

coderabbitai bot commented Jun 12, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

Update dependencies and configuration files #846

Update dependencies and configuration files #846

Conversation

kamiazya commented Jun 12, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

changeset-bot bot commented Jun 12, 2024 • edited Loading

🦋 Changeset detected

coderabbitai bot commented Jun 12, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

kamiazya commented Jun 12, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jun 12, 2024 •

edited

Loading

coderabbitai bot commented Jun 12, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)